/* 
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

using System;
using Lucene.Net.Util;
using System.Collections.Generic;

namespace Lucene.Net.Search
{

    /// <summary> Represents hits returned by {@link
    /// * Searcher#search(Query,Filter,int)} and {@link
    /// * Searcher#search(Query,int)
    /// </summary>
    [Serializable]
    public class TopDocs
    {
        /// <summary>The total number of hits for the query.</summary>
        /// <seealso cref="Hits.Length()">
        /// </seealso>
        public int totalHits;
        /// <summary>The top hits for the query. </summary>
        public ScoreDoc[] scoreDocs;
        /// <summary>Stores the maximum score value encountered, needed for normalizing. </summary>
        private float maxScore;

        public Dictionary<string, int> GroupCount;

        /// <summary>Returns the maximum score value encountered. Note that in case
        /// scores are not tracked, this returns {@link Float#NaN}.
        /// </summary>
        public virtual float GetMaxScore()
        {
            return maxScore;
        }

        /// <summary>Sets the maximum score value encountered. </summary>
        public virtual void SetMaxScore(float maxScore)
        {
            this.maxScore = maxScore;
        }

        /// <summary>Constructs a TopDocs with a default maxScore=Float.NaN. </summary>
        internal TopDocs(int totalHits, ScoreDoc[] scoreDocs)
            : this(totalHits, scoreDocs, System.Single.NaN)
        {
        }

        /// <summary>Constructs a TopDocs with a default maxScore=Float.NaN.--add by lucky </summary>
        internal TopDocs(int totalHits, ScoreDoc[] scoreDocs, Dictionary<string, int> GroupCount)
            : this(totalHits, scoreDocs, System.Single.NaN, GroupCount)
        {
        }

        /// <summary></summary>
        public TopDocs(int totalHits, ScoreDoc[] scoreDocs, float maxScore)
        {
            this.totalHits = totalHits;
            this.scoreDocs = scoreDocs;
            this.maxScore = maxScore;
        }

        /// <summary>add by lucky</summary>
        public TopDocs(int totalHits, ScoreDoc[] scoreDocs, float maxScore, Dictionary<string, int> GroupCount)
        {
            this.totalHits = totalHits;
            this.scoreDocs = scoreDocs;
            this.maxScore = maxScore;
            this.GroupCount = GroupCount;
        }
    }
}